Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Protected Attributes |
List of all members
kanzi::TextConceptImpl< TDerivedClass > Class Template Reference
TextConceptImpl provides the common base implementation for text rendering nodes. More...
#include <kanzi/ui/node/concept/text_concept.hpp>
Inheritance diagram for kanzi::TextConceptImpl< TDerivedClass >:
Static Public Member Functions | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
 Static Public Member Functions inherited from kanzi::TextConcept | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Protected Member Functions | |
| void | prepareTextFormat (const TextFormatParameters ¶meters, string text) |
| Updates the parameters and text of the internal text format. | |
| TextConceptImpl ()=default | |
| Constructor. | |
Protected Attributes | |
| TextFormatPtr | m_textFormat |
| The text format for the text that this node displays. | |
Additional Inherited Members | |
| Static Public Attributes inherited from kanzi::TextConcept | |
| static PropertyType< ColorRGBA > | FontColorProperty |
| Sets the text color for the default font material and for the materials with a fragment shader that uses the FontColor uniform. | |
| static PropertyType< ResourceSharedPtr > | FontMaterialProperty |
| Sets the material whose shader is used to render the text in a 3D text node. | |
| static PropertyType< string > | TextProperty |
| Sets the text content that a text node renders. | |
| static PropertyType< TextFormat::TextHorizontalAlignment > | TextHorizontalAlignmentProperty |
| Sets the horizontal alignment of the text in a text node. | |
| static PropertyType< TextFormat::TextVerticalAlignment > | TextVerticalAlignmentProperty |
| Sets the vertical alignment of the text in a text node. | |
| static PropertyType< Vector2 > | HorizontalPaddingProperty |
| Sets the padding spaces between the content and the left and right boundaries of a text node. | |
| static PropertyType< Vector2 > | VerticalPaddingProperty |
| Sets the padding spaces between the content and the top and bottom boundaries of a text node. | |
| static PropertyType< string > | OverflowProperty |
| Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in a text node. | |
| static PropertyType< TextFormat::Truncation > | TruncationProperty |
| Sets how to truncate the text when the text string to be rendered is too long to fit in a node. | |
| static PropertyType< TextFormat::TruncationDirection > | TruncationDirectionProperty |
| Sets which part of the text to truncate when the text string to be rendered is too long to fit in a node. | |
| static PropertyType< bool > | RemoveSideBearingsProperty |
| Sets the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node. | |
| static PropertyType< bool > | HorizontalFitProperty |
| Allows a Text Block to scale glyphs horizontally when the text string is too long to fit in that Text Block. | |
| static PropertyType< Vector2 > | HorizontalFitScaleLimitsProperty |
| Sets the scale range that the HorizontalFitProperty can use when it scales the text horizontally. | |
Detailed Description
TextConceptImpl provides the common base implementation for text rendering nodes.
It encapsulates TextFormat, which is responsible for text layouting and rendering.
TextConceptImpl derives from TextConcept, which defines the data and property types used by the implementation. Do not use these classes directly. Instead use:
- TextBlock2D and TextBlock3D to show a small amount of text in your application.
- TextBox2D and TextBox3D to add single-line text input to your application.
To implement your own text rendering node:
- Derive from TextConceptImpl and FontStyleConceptImpl.
Implement the
void notifyPostPrepareTextFormat(bool)method.Kanzi calls this method after the underlying TextFormat updates the layout of the text. The only boolean parameter of this function indicates whether the text was relayouted.
To update the text layout, call prepareTextFormat().
Kanzi updates the underlying TextFormat with the parameters that you pass to the function and the parameters taken from FontStyleConceptImpl.
- To render text use the TextConceptImpl::m_textFormat member.
- Since
- Kanzi 3.9.0
Constructor & Destructor Documentation
◆ ~TextConceptImpl()
template<typename TDerivedClass >
|
virtualdefault |
Destructor.
◆ TextConceptImpl()
template<typename TDerivedClass >
|
explicitprotecteddefault |
Constructor.
Member Function Documentation
◆ makeEditorInfo()
template<typename TDerivedClass >
|
static |
◆ getFontColor()
template<typename TDerivedClass >
| ColorRGBA kanzi::TextConceptImpl< TDerivedClass >::getFontColor | ( | ) | const |
Gets the value of the FontColorProperty.
- Returns
- The color value of the default font material, or the color value of materials with fragment shader that uses the FontColor uniform. Returns the value in range [0,1].
- See also
- setFontColor()
◆ setFontColor()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setFontColor | ( | ColorRGBA | value | ) |
Sets the value of the FontColorProperty.
- Parameters
-
value The ColorRGBA color value of the font material with fragment shader that uses the FontColor uniform.
- See also
- getFontColor()
◆ getFontMaterial()
template<typename TDerivedClass >
| MaterialSharedPtr kanzi::TextConceptImpl< TDerivedClass >::getFontMaterial | ( | ) | const |
Gets the value of the FontMaterialProperty.
- Returns
- The font material currently in use.
- See also
- setFontMaterial()
◆ setFontMaterial()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setFontMaterial | ( | MaterialSharedPtr | value | ) |
Sets the value of the FontMaterialProperty.
- Parameters
-
value The font material.
- See also
- getFontMaterial()
◆ getHorizontalPadding()
template<typename TDerivedClass >
| Vector2 kanzi::TextConceptImpl< TDerivedClass >::getHorizontalPadding | ( | ) | const |
Gets the value of HorizontalPaddingProperty.
- Returns
- The space on the left and the right sides of the content.
- See also
- setHorizontalPadding()
◆ setHorizontalPadding()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setHorizontalPadding | ( | Vector2 | value | ) |
Sets the value of HorizontalPaddingProperty.
- Parameters
-
value The space on the left and the right sides of the content.
- See also
- getHorizontalPadding()
◆ getText()
template<typename TDerivedClass >
| string kanzi::TextConceptImpl< TDerivedClass >::getText | ( | ) | const |
Gets the value of TextProperty.
- See also
- setText()
◆ setText()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setText | ( | string | value | ) |
Sets the value of TextProperty.
- See also
- getText()
◆ getTextHorizontalAlignment()
template<typename TDerivedClass >
| TextFormat::TextHorizontalAlignment kanzi::TextConceptImpl< TDerivedClass >::getTextHorizontalAlignment | ( | ) | const |
Gets the value of the TextHorizontalAlignmentProperty.
- Returns
- The horizontal alignment of the object.
- See also
- setTextHorizontalAlignment()
◆ setTextHorizontalAlignment()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setTextHorizontalAlignment | ( | TextFormat::TextHorizontalAlignment | value | ) |
Sets the value of the TextHorizontalAlignmentProperty.
- Parameters
-
value One of the TextFormat::TextHorizontalAlignment enumerator values.
- See also
- getTextHorizontalAlignment()
◆ getTextVerticalAlignment()
template<typename TDerivedClass >
| TextFormat::TextVerticalAlignment kanzi::TextConceptImpl< TDerivedClass >::getTextVerticalAlignment | ( | ) | const |
Gets the value of the TextVerticalAlignmentProperty.
- Returns
- The vertical alignment of the object.
- See also
- setTextVerticalAlignment()
◆ setTextVerticalAlignment()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setTextVerticalAlignment | ( | TextFormat::TextVerticalAlignment | value | ) |
Sets the value of the TextVerticalAlignmentProperty.
- Parameters
-
value One of the TextFormat::TextVerticalAlignment enumerator values.
- See also
- getTextVerticalAlignment()
◆ getVerticalPadding()
template<typename TDerivedClass >
| Vector2 kanzi::TextConceptImpl< TDerivedClass >::getVerticalPadding | ( | ) | const |
Gets the value of VerticalPaddingProperty.
- Returns
- The space on the top and the bottom of the content.
- See also
- setVerticalPadding()
◆ setVerticalPadding()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setVerticalPadding | ( | Vector2 | value | ) |
Sets the value of VerticalPaddingProperty.
- Parameters
-
value The space on the top and the bottom of the content.
- See also
- getVerticalPadding()
◆ getOverflow()
template<typename TDerivedClass >
| string kanzi::TextConceptImpl< TDerivedClass >::getOverflow | ( | ) | const |
Gets the value of the OverflowProperty.
- Returns
- The characters that represent the truncated text when the text string is too long to fit in the node.
- See also
- setOverflow()
◆ setOverflow()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setOverflow | ( | string_view | value | ) |
Sets the value of the OverflowProperty.
- Parameters
-
value The characters that represent the truncated text when the text string is too long to fit in the node.
- See also
- getOverflow()
◆ getHorizontalFit()
template<typename TDerivedClass >
| bool kanzi::TextConceptImpl< TDerivedClass >::getHorizontalFit | ( | ) | const |
Gets the value of the HorizontalFitProperty.
- Returns
- If the Text Block allows horizontal scaling of glyphs, true, otherwise false.
◆ setHorizontalFit()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setHorizontalFit | ( | bool | value | ) |
Sets the value of the HorizontalFitProperty.
- Parameters
-
value Whether to enable the horizontal scaling of glyphs when the text string is too long to fit in that Text Block.
◆ getHorizontalFitScaleLimits()
template<typename TDerivedClass >
| Vector2 kanzi::TextConceptImpl< TDerivedClass >::getHorizontalFitScaleLimits | ( | ) | const |
Gets the value of the HorizontalFitScaleLimitsProperty.
- Returns
- The minimum and maximum amount to which the HorizontalFitProperty can scale the glyphs in a Text Block node.
◆ setHorizontalFitScaleLimits()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setHorizontalFitScaleLimits | ( | Vector2 | value | ) |
Sets the value of the HorizontalFitScaleLimitsProperty.
- Parameters
-
value When the HorizontalFitProperty is enabled, sets the minimum and maximum scale for glyphs when the width of text in a Text Block does not match the Layout Width property of that Text Block. For example: - Min property field set to 1.0 does not squeeze the glyphs, while 0.5 allows squeezing the glyphs to half their size.
- Max property field set to 1.0 does not stretch the glyphs, while 2.0 allows stretching the glyphs to double their size.
◆ getRemoveSideBearings()
template<typename TDerivedClass >
| bool kanzi::TextConceptImpl< TDerivedClass >::getRemoveSideBearings | ( | ) | const |
Gets the value of the RemoveSideBearingsProperty.
- Returns
- If the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text are to be exactly within the boundary of the text node, true, otherwise false.
◆ setRemoveSideBearings()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setRemoveSideBearings | ( | bool | value | ) |
Sets the value of the RemoveSideBearingsProperty.
- Parameters
-
value The value that determines if the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text are to be exactly within the boundary of the text node or not.
◆ setTruncationDirection()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setTruncationDirection | ( | TextFormat::TruncationDirection | value | ) |
Sets the value of the TruncationDirectionProperty.
- Parameters
-
value The truncation direction for the text that does not fit in the node.
- Since
- Kanzi 3.9.6
◆ getTruncationDirection()
template<typename TDerivedClass >
| TextFormat::TruncationDirection kanzi::TextConceptImpl< TDerivedClass >::getTruncationDirection | ( | ) | const |
Gets the value of the TruncationDirectionProperty.
- Returns
- The truncation direction for the text that does not fit in the node.
- Since
- Kanzi 3.9.6
◆ setTruncation()
template<typename TDerivedClass >
| void kanzi::TextConceptImpl< TDerivedClass >::setTruncation | ( | TextFormat::Truncation | value | ) |
Sets the value of the TruncationProperty.
- Parameters
-
value Truncation policy for the text that does not fit in the node.
- Since
- Kanzi 3.9.6
◆ getTruncation()
template<typename TDerivedClass >
| TextFormat::Truncation kanzi::TextConceptImpl< TDerivedClass >::getTruncation | ( | ) | const |
Gets the value of the TruncationProperty.
- Returns
- Truncation policy for the text that does not fit in the node.
- Since
- Kanzi 3.9.6
◆ prepareTextFormat()
template<typename TDerivedClass >
|
protected |
Updates the parameters and text of the internal text format.
Calls notifyPostPrepareTextFormat() when the text format is created or reused successfully.
- Parameters
-
parameters Collection of parameters that are used to configure the text format. text The text that is layouted using the text format.
Member Data Documentation
◆ m_textFormat
template<typename TDerivedClass >
|
protected |
The text format for the text that this node displays.
The documentation for this class was generated from the following files:
- kanzi/ui/node/concept/text_concept.hpp
- kanzi/ui/node/concept/text_concept_impl.hpp